'\" te
.\" This manual page is derived from the DAT/uDAPL 1.2 specification.
.\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH DAT_STRERROR 3DAT "Jul 16, 2004"
.SH NAME
dat_strerror \- convert a DAT return code into human readable strings
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <\fBdat/udat.h\fR>

DAT_RETURN
    dat_strerror(
    IN    DAT_RETURN    return,
    OUT   const char    **major_message,
    OUT   const char    **minor_message
    )
.fi

.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIreturn\fR\fR
.ad
.RS 11n
DAT function return value.
.RE

.sp
.ne 2
.na
\fB\fImessage\fR\fR
.ad
.RS 11n
A pointer to a character string for the return.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBdat_strerror()\fR function converts a DAT return code into human
readable strings. The \fImajor_message\fR is a string-converted
\fBDAT_TYPE_STATUS\fR, while \fIminor_message\fR is a string-converted
\fBDAT_SUBTYPE_STATUS\fR. If the return of this function is not
\fBDAT_SUCCESS\fR, the values of \fImajor_message\fR and \fIminor_message\fR
are not defined.
.sp
.LP
If an undefined \fBDAT_RETURN\fR value was passed as the return parameter, the
operation fails with \fBDAT_INVALID_PARAMETER\fR returned. The operation
succeeds when \fBDAT_SUCCESS\fR is passed in as the return parameter.
.SH RETURN VALUES
.sp
.ne 2
.na
\fB\fBDAT_SUCCESS\fR\fR
.ad
.RS 25n
The operation was successful.
.RE

.sp
.ne 2
.na
\fB\fBDAT_INVALID_PARAMETER\fR\fR
.ad
.RS 25n
Invalid parameter. The \fIreturn\fR value is invalid.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard: uDAPL, 1.1, 1.2
_
MT-Level	Safe
.TE

.SH SEE ALSO
.sp
.LP
.BR libdat (3LIB),
.BR attributes (7)
